From e21f5b414c8792bbc250ee9d98680d64376e5644 Mon Sep 17 00:00:00 2001 From: Dale Wijnand Date: Fri, 20 Apr 2018 19:29:42 +0100 Subject: [PATCH] add contributing notes for cross compile test setup --- CONTRIBUTING.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b05c79306..fc5a590b2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -78,7 +78,10 @@ in `test/` provide templates on how to test Cargo's behavior in a sandbox-environment. The internal crate `cargotest` provides a vast amount of helpers to minimize boilerplate. * Make sure `cargo test` passes. If you do not have the cross-compilers -installed locally, ignore the cross-compile test failures or disable them by +installed locally, install them using the instructions returned by +`cargo test cross_compile::cross_tests` (twice, with `--toolchain nightly` +added to get the nightly cross target too); alternatively just +ignore the cross-compile test failures or disable them by using `CFG_DISABLE_CROSS_TESTS=1 cargo test`. Note that some tests are enabled only on `nightly` toolchain. If you can, test both toolchains. * All code changes are expected to comply with the formatting suggested by `rustfmt`. -- 2.30.2